home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_cyrus-imapd.idb / usr / freeware / sbin / cyradm.z / cyradm
Text File  |  2001-07-06  |  10KB  |  329 lines
  1. #! /bin/sh
  2. # 
  3. # Copyright (c) 2000 Carnegie Mellon University.  All rights reserved.
  4. #
  5. # Redistribution and use in source and binary forms, with or without
  6. # modification, are permitted provided that the following conditions
  7. # are met:
  8. #
  9. # 1. Redistributions of source code must retain the above copyright
  10. #    notice, this list of conditions and the following disclaimer. 
  11. #
  12. # 2. Redistributions in binary form must reproduce the above copyright
  13. #    notice, this list of conditions and the following disclaimer in
  14. #    the documentation and/or other materials provided with the
  15. #    distribution.
  16. #
  17. # 3. The name "Carnegie Mellon University" must not be used to
  18. #    endorse or promote products derived from this software without
  19. #    prior written permission. For permission or any other legal
  20. #    details, please contact  
  21. #      Office of Technology Transfer
  22. #      Carnegie Mellon University
  23. #      5000 Forbes Avenue
  24. #      Pittsburgh, PA  15213-3890
  25. #      (412) 268-4387, fax: (412) 268-7395
  26. #      tech-transfer@andrew.cmu.edu
  27. #
  28. # 4. Redistributions of any form whatsoever must retain the following
  29. #    acknowledgment:
  30. #    "This product includes software developed by Computing Services
  31. #     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
  32. #
  33. # CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  34. # THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  35. # AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  36. # FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  37. # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  38. # AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  39. # OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  40. #
  41. #
  42. case "x$BASH_VERSION" in
  43. x) exec /usr/bin/perl5 -MCyrus::IMAP::Shell -e shell -- ${1+"$@"} ;;
  44. *) exec /usr/bin/perl5 -MCyrus::IMAP::Shell -e shell -- "$@" ;;
  45. esac
  46. echo "$0: how did I get here?" >&2
  47. exit 1
  48.  
  49. =head1 NAME
  50.  
  51. cyradm - Cyrus administration shell, alter ego of Cyrus::IMAP::Shell
  52.  
  53. =head1 SYNOPSIS
  54.  
  55.   $ cyradm [--user user] [--[no]rc] [--systemrc file] [--userrc file] \
  56.   > [--port n] [--auth mechanism] [--server] server
  57.  
  58. but possibly
  59.  
  60.   $ perl -MCyrus::IMAP::Shell -e 'run("myscript")'
  61.  
  62. or even (not recommended)
  63.  
  64.   use IMAP::Admin::Shell;
  65.  
  66.   run('myscriptname');
  67.  
  68. =head1 DESCRIPTION
  69.  
  70. This module implements B<cyradm> in Perl.  It is a shell around
  71. L<Cyrus::IMAP::Admin>.  Commands are provided in both Tcl-compatible
  72. forms and GNU-style long option forms.
  73.  
  74. =head1 COMMANDS
  75.  
  76. =over 4
  77.  
  78. =item C<authenticate> [C<--minssf> I<N>] [C<--maxssf> I<N>] [C<--mechanisms> I<list>] [I<user>]
  79.  
  80. =item C<auth> [C<--minssf> I<N>] [C<--maxssf> I<N>] [C<--mechanisms> I<list>] [I<user>]
  81.  
  82. =item C<login> [C<--minssf> I<N>] [C<--maxssf> I<N>] [C<--mechanisms> I<list>] [I<user>]
  83.  
  84. Authenticate to server.  You must already be connected to a server and
  85. Cyrus imapd will refuse to allow you to re-authenticate once you have
  86. authenticated once.
  87.  
  88. =item C<chdir> I<directory>
  89.  
  90. =item C<cd> I<directory>
  91.  
  92. Change directory.  A C<pwd> builtin is not provided, but the default command
  93. action will run C<pwd> from a shell if invoked.
  94.  
  95. =item C<createmailbox> [C<--partition> I<partition>] I<mailbox>
  96.  
  97. =item C<createmailbox> I<mailbox> I<partition>
  98.  
  99. =item C<create> [C<--partition> I<partition>] I<mailbox>
  100.  
  101. =item C<create> I<mailbox> I<partition>
  102.  
  103. =item C<cm> [C<--partition> I<partition>] I<mailbox>
  104.  
  105. =item C<cm> I<mailbox> I<partition>
  106.  
  107. Create a mailbox on the default or a specified partition.  Both old-style
  108. and getopt-style usages are accepted (combining them will produce an error).
  109.  
  110. =item C<deleteaclmailbox> I<mailbox> I<id> [...]
  111.  
  112. =item C<deleteacl> I<mailbox> I<id> [...]
  113.  
  114. =item C<dam> I<mailbox> I<id> [...]
  115.  
  116. Remove ACLs from the specified mailbox.
  117.  
  118. =item C<deletemailbox> I<mailbox>
  119.  
  120. =item C<delete> I<mailbox>
  121.  
  122. =item C<dm> I<mailbox>
  123.  
  124. Delete the specified mailbox.
  125.  
  126. Administrators do not have implicit delete rights on mailboxes.  Use the
  127. B<setaclmailbox> command to grant the C<d> permission to your principal
  128. if you need to delete a mailbox you do not own.
  129.  
  130. Note that the online help admits to an optional host argument.  This argument
  131. is not currently used, and will be rejected with an error if specified; it
  132. is reserved for IMSP.
  133.  
  134. =item C<disconnect>
  135.  
  136. =item C<disc>
  137.  
  138. Disconnect from the current server.  The prompt will revert to C<cyradmE<gt>>.
  139.  
  140. =item C<exit> [I<number>]
  141.  
  142. =item C<quit> [I<number>]
  143.  
  144. Exit B<cyradm>, optionally with a specific exit status; the exit status of the
  145. last command will be used if one is not specified.
  146.  
  147. =item help [command]
  148.  
  149. =item ? [command]
  150.  
  151. Show help for C<command> or all commands.
  152.  
  153. =item listaclmailbox I<mailbox>
  154.  
  155. =item listacl I<mailbox>
  156.  
  157. =item lam I<mailbox>
  158.  
  159. List ACLs on the specified mailbox.
  160.  
  161. =item C<listmailbox> [C<--subscribed>] [I<pattern> [I<reference>]]
  162.  
  163. =item C<list> [C<--subscribed>] [I<pattern> [I<reference>]]
  164.  
  165. =item C<lm> [C<--subscribed>] [I<pattern> [I<reference>]]
  166.  
  167. List all, or all subscribed, mailboxes matching the specified pattern.
  168. The pattern may have embedded wildcards C<'*'> or C<'%'>, which match
  169. anything or anything except the separator character, respectively.
  170.  
  171. Mailboxes returned will be relative to the specified reference if one
  172. is specified.  This allows a mailbox list to be limited to a particular
  173. hierarchy.
  174.  
  175. In some cases when the C<'%'> wildcard is used to end a pattern, it may
  176. match an entry which is not a mailbox but which contains other mailboxes.
  177. In this case, the entry will be parenthesized to indicate that it is a
  178. root for other mailboxes, as opposed to a mailbox itself.
  179.  
  180. =item C<listquota> I<root>
  181.  
  182. =item C<lq> I<root>
  183.  
  184. List quotas on specified root.  If the specified mailbox path does not have
  185. a quota assigned, an error will be raised; see L<listquotaroot> for a way to
  186. find the quota root for a mailbox.
  187.  
  188. =item C<listquotaroot> I<mailbox>
  189.  
  190. =item C<lqm> I<mailbox>
  191.  
  192. =item C<lqr> I<mailbox?>
  193.  
  194. show quota roots and quotas for mailbox
  195.  
  196. =item C<renamemailbox> [C<--partition> I<partition>] I<oldname> I<newname>
  197.  
  198. =item C<rename> [C<--partition> I<partition>] I<oldname> I<newname>
  199.  
  200. =item C<renm> [C<--partition> I<partition>] I<oldname> I<newname>
  201.  
  202. =item C<renamemailbox> I<oldname> I<newname> [I<partition>]
  203.  
  204. =item C<rename> I<oldname> I<newname> [I<partition>]
  205.  
  206. =item C<renm> I<oldname> I<newname> [I<partition>]
  207.  
  208. Rename the specified mailbox, optionally moving it to a different partition.
  209. Both old-style and getopt-style usages are accepted; combining them will
  210. produce an error.
  211.  
  212. =item server [--noauthenticate] [server]
  213.  
  214. =item connect [--noauthenticate] [server]
  215.  
  216. =item servername [--noauthenticate] [server]
  217.  
  218. With no arguments, show the current server.  With an argument, connect to that
  219. server.  It will prompt for automatic login unless the C<--noauthenticate>
  220. option is specified.  (This may change; in particular, either automatic
  221. authentication will be removed or all C<authenticate> options will be added.)
  222.  
  223. When connected to a server, B<cyradm>'s prompt changes from C<cyradmE<gt>> to
  224. C<servernameE<gt>>, where I<servername> is the fully qualified domain name
  225. of the connected server.
  226.  
  227. =item C<setaclmailbox> I<mailbox> I<id> I<rights> [I<id> I<rights> ...]
  228.  
  229. =item C<setacl> I<mailbox> I<id> I<rights> [I<id> I<rights> ...]
  230.  
  231. =item C<sam> I<mailbox> I<id> I<rights> [I<id> I<rights> ...]
  232.  
  233. Set ACLs on a mailbox.  The ACL may be one of the special strings C<none>,
  234. C<read> (C<lrs>), C<post> (C<lrsp>), C<append> (C<lrsip>), C<write>
  235. (C<lrswipcd>), or C<all> (C<lrswipcda>), or any combinations of the ACL codes:
  236.  
  237. =over 4
  238.  
  239. =item l
  240.  
  241. Lookup (visible to LIST/LSUB/UNSEEN)
  242.  
  243. =item r
  244.  
  245. Read (SELECT, CHECK, FETCH, PARTIAL, SEARCH, COPY source)
  246.  
  247. =item s
  248.  
  249. Seen (STORE \SEEN)
  250.  
  251. =item w
  252.  
  253. Write flags other than \SEEN and \DELETED
  254.  
  255. =item i
  256.  
  257. Insert (APPEND, COPY destination)
  258.  
  259. =item p
  260.  
  261. Post (send mail to mailbox)
  262.  
  263. =item c
  264.  
  265. Create (subfolders)
  266.  
  267. =item d
  268.  
  269. Delete (STORE \DELETED, EXPUNGE)
  270.  
  271. =item a
  272.  
  273. Administer (SETACL)
  274.  
  275. =back
  276.  
  277. =item C<setquota> I<root> I<resource> I<value> [I<resource> I<value> ...]
  278.  
  279. =item C<sq> I<root> I<resource> I<value> [I<resource> I<value> ...]
  280.  
  281. Set a quota on the specified root, which may or may not be an actual mailbox.
  282. The only I<resource> understood by B<Cyrus> is C<STORAGE>.
  283.  
  284. =back
  285.  
  286. =head1 NOTES
  287.  
  288. GNU-style long options must be given in their entirety; Tcl-style options
  289. may be abbreviated.
  290.  
  291. Tcl-style options are provided as a compatibility feature.  They will
  292. probably go away in the future.
  293.  
  294. Multiple commands can be given on a line, separated by C<';'> characters.
  295.  
  296. All commands set an exit status, which at present is not useful.
  297.  
  298. Unknown commands are passed to a subshell for execution.
  299.  
  300. The Tcl version of B<cyradm> is used for scripting as well as interactively.
  301. While this is possible to a limited extent by use of the C<run> method,
  302. scripting would normally be done with C<Cyrus::IMAP::Admin>, which is far
  303. more flexible than either interactive C<cyradm> or the Tcl scripting
  304. mechanism for Cyrus.
  305.  
  306. B<cyradm> understands B</bin/sh>-style redirection:  any command can have
  307. its standard or error output redirected, with all B<sh>-style redirections
  308. (except C<E<lt>E<gt>>) supported.  It does not currently understand pipes
  309. or backgrounding.
  310.  
  311. If the C<Term::Readline::Perl> or C<Term::Readline::GNU> modules are
  312. available, B<cyradm> will use it.
  313.  
  314. An alias facility is implemented internally, but no access is currently
  315. provided to it.  This will change, if only to allow some of the predefined
  316. aliases to be removed if they conflict with useful shell commands.
  317.  
  318. =head1 AUTHOR
  319.  
  320. Brandon S. Allbery, allbery@ece.cmu.edu
  321.  
  322. =head1 SEE ALSO
  323.  
  324. Cyrus::IMAP::Admin
  325. Term::ReadLine
  326. sh(1), perl(1), imapd(8).
  327.  
  328. =cut
  329.